Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds simple documentation for the test executions code lenses #196

Merged
merged 1 commit into from
Jul 19, 2021

Conversation

Blond11516
Copy link
Contributor

@Blond11516 Blond11516 commented Jul 1, 2021

Documents the test execution code lenses as an experimental feature.

I wasn't quite sure how to integrate this with the rest of the README. I opted for an independent "Experimental Features" section as I feel these are not as important as the configuration, troubleshooting, etc.

Comment on lines +129 to +131
#### Known issues

- The generated command sometimes fails to properly execute tests in umbrella apps. See [this comment](https://github.com/elixir-lsp/elixir-ls/issues/438#issuecomment-871861880) for more details.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As per this and the few following comments, this issue seems to be more about elixir-ls' test setup than the test lenses, so I guess this could be removed.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's better to leave it in for now in the chance that it affects other projects as well, and other projects may use a similar alias in their tests.

Copy link
Member

@axelson axelson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! ❤️

Comment on lines +129 to +131
#### Known issues

- The generated command sometimes fails to properly execute tests in umbrella apps. See [this comment](https://github.com/elixir-lsp/elixir-ls/issues/438#issuecomment-871861880) for more details.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's better to leave it in for now in the chance that it affects other projects as well, and other projects may use a similar alias in their tests.

@axelson axelson merged commit f5c2a29 into elixir-lsp:master Jul 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants